CZERTAINLY Core API (1.5.1-SNAPSHOT)

Download OpenAPI specification:Download

CZERTAINLY: getinfo@czertainly.com URL: https://www.czertainly.com License: MIT License

REST API for CZERTAINLY Core

CZERTAINLY Documentation

Connector Management

Connector Management API

Reconnect to a Connector

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

Content type

application/json

[{"functionGroup": {"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
}
]

Approve a Connector

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Get details of a Connector

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
],
"url": "http://network-discovery-provider:8080",
"authType": "none",
"authAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "CONNECTED",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Edit a Connector

path Parameters

uuid

required

string

Connector UUID

Request Body schema: application/json

url	string URL of the Connector to connect
authType	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttributeDto) List of authentication Attributes. Required if the authentication type is not NONE
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"url": "http://network-discovery-provicer:8080",
"authType": "none",
"authAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
],
"url": "http://network-discovery-provider:8080",
"authType": "none",
"authAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "CONNECTED",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Delete a Connector

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Reconnect multiple Connectors

Request Body schema: application/json

Connector UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Connect to a Connector

Request Body schema: application/json

url required	string URL of the Connector to connect
uuid	string UUID of the Connector. Mandatory if connection is needed for the same Connector
authType required	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttributeDto) List of authentication Attributes. Required if the authentication type is not NONE

Responses

Request samples

Payload

Content type

application/json

{"url": "http://network-discovery-provicer:8080",
"uuid": "string",
"authType": "none",
"authAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

[{"functionGroup": {"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
}
]

Approve multiple Connector

Request Body schema: application/json

Connector UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Validate Attributes

path Parameters

uuid required	string Connector UUID
functionGroup required	string Function Group name
kind required	string Kind

Request Body schema: application/json

Array

uuid	string UUID of the Attribute
name required	string Name of the Attribute
required	Array of BooleanAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContent) Content of the Attribute

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

List Connectors by Function Group and Kind

query Parameters

functionGroup	string (FunctionGroupCode) Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" Enumerated code of functional group
kind	string
status	string (ConnectorStatus) Enum: "waitingForApproval" "connected" "failed" "offline" Example: status=CONNECTED Status of the Connector

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
],
"url": "http://network-discovery-provider:8080",
"authType": "none",
"authAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "CONNECTED",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
]

Create a new Connector

Request Body schema: application/json

name required	string Name of the Connector
url required	string URL of the Connector to connect
authType required	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttributeDto) List of authentication Attributes. Required if the authentication type is not NONE
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "Connector1",
"url": "http://network-discovery-provicer:8080",
"authType": "none",
"authAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"uuid": "string"
}

Delete multiple Connectors

Request Body schema: application/json

Connector UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Check Health of a Connector

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

Content type

application/json

{"status": "ok",
"description": "string",
"parts": {"property1": { },
"property2": { }
}
}

Get Attributes from a Connector

path Parameters

uuid required	string Connector UUID
functionGroup required	string (FunctionGroupCode) Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" Function Group name
kind required	string Kind

Responses

Response samples

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Get attributes of all Function Groups

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

Content type

application/json

{"property1": {"property1": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
],
"property2": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]
},
"property2": {"property1": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
],
"property2": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]
}
}

Force Delete multiple Connectors

Request Body schema: application/json

Connector UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Custom Attributes

Custom Attributes API

Custom Attribute details

path Parameters

uuid

required

string

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"name": "string",
"contentType": "Attribute",
"description": "string",
"enabled": true,
"type": "data",
"label": "Attribute Name",
"required": true,
"visible": true,
"group": "requiredAttributes",
"readOnly": false,
"list": false,
"multiSelect": false,
"content": [{"reference": "string",
"data": true
}
],
"resources": ["NONE"
]
}

Edit Custom Attribute

path Parameters

uuid

required

string

Attribute UUID

Request Body schema: application/json

description required	string Attribute description
label required	string Friendly name of the the Attribute
visible	boolean Default: true Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user.
group	string Group of the Attribute, used for the logical grouping of the Attribute
required	boolean Default: false Boolean determining if the Attribute is required. If true, the Attribute must be provided.
readOnly	boolean Default: false Boolean determining if the Attribute is read only. If true, the Attribute content cannot be changed.
list	boolean Default: false Boolean determining if the Attribute contains list of values in the content
multiSelect	boolean Default: false Boolean determining if the Attribute can have multiple values
	Array of BooleanAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContent) Predefined content for the attribute if needed. The content of the Attribute must satisfy the type

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"content": [{"reference": "string",
"data": true
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"name": "string",
"contentType": "Attribute",
"description": "string",
"enabled": true,
"type": "data",
"label": "Attribute Name",
"required": true,
"visible": true,
"group": "requiredAttributes",
"readOnly": false,
"list": false,
"multiSelect": false,
"content": [{"reference": "string",
"data": true
}
],
"resources": ["NONE"
]
}

Delete Custom Attribute

path Parameters

uuid

required

string

Custom Attribute UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List Custom Attributes

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "string",
"name": "string",
"contentType": "Attribute",
"description": "string",
"enabled": true
}
]

Create Custom Attribute

Request Body schema: application/json

name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "integer" "secret" "file" "boolean" "credential" "date" "float" "object" "text" "time" "datetime" Content Type of the Attribute
description required	string Attribute description
label required	string Friendly name of the the Attribute
visible	boolean Default: true Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user.
group	string Group of the Attribute, used for the logical grouping of the Attribute
required	boolean Default: false Boolean determining if the Attribute is required. If true, the Attribute must be provided.
readOnly	boolean Default: false Boolean determining if the Attribute is read only. If true, the Attribute content cannot be changed.
list	boolean Default: false Boolean determining if the Attribute contains list of values in the content
multiSelect	boolean Default: false Boolean determining if the Attribute can have multiple values
	Array of BooleanAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContent) Predefined content for the attribute if needed. The content of the Attribute must satisfy the type

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"contentType": "Attribute",
"description": "string",
"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"content": [{"reference": "string",
"data": true
}
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "string"
}

Delete multiple Custom Attributes

Request Body schema: application/json

Attribute UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Associate Custom Attribute to Resource

path Parameters

uuid

required

string

Custom Attribute UUID

Request Body schema: application/json

List of Resources

Array

string

Responses

Request samples

Payload

Content type

application/json

["raProfiles",
"authorities"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable Custom Attribute

path Parameters

uuid

required

string

Custom Attribute UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable Custom Attribute

path Parameters

uuid

required

string

Custom Attribute UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable multiple Custom Attributes

Request Body schema: application/json

Attribute UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable multiple Custom Attributes

Request Body schema: application/json

Attribute UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Custom Attributes for a resource

path Parameters

resource

required

string (Resource)

Enum: "NONE" "dashboard" "auditLogs" "credentials" "connectors" "users" "roles" "acmeAccounts" "acmeProfiles" "authorities" "raProfiles" "certificates" "certificateGroups" "complianceProfiles" "discoveries" "entities" "locations" "attributes"

Resource Name

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Get available resources for Custom Attributes

Responses

Response samples

200
400
403
404

Content type

application/json

["NONE"
]

User Management

User Management API

Add role to User

path Parameters

userUuid required	string User UUID
roleUuid required	string Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Remove role from User

path Parameters

userUuid required	string User UUID
roleUuid required	string Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Get user details

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Update User

path Parameters

userUuid

required

string

User UUID

Request Body schema: application/json

description	string Description of the user
firstName	string First name of the user
lastName	string Last name of the user
email required	string Email of the user
certificateData	string Base64 Content of the admin certificate
certificateUuid	string UUID of the existing certificate in the Inventory. Mandatory if certificate is not provided
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"certificateData": "string",
"certificateUuid": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Delete User

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

400
403
404

Content type

application/json

{"statusCode": 0,
"code": "string",
"message": "string"
}

List Users

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true
}
]

Create User

Request Body schema: application/json

username required	string Username of the user
description	string Description of the user
firstName	string First name of the user
lastName	string Last name of the user
email	string Email of the user
enabled	boolean Status of the user. True = Enabled, False = Disabled
certificateData	string Base64 Content of the user certificate
certificateUuid	string UUID of the existing certificate in the Inventory
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"username": "user1",
"description": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"enabled": true,
"certificateData": "string",
"certificateUuid": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Get User Roles

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true
}
]

Add roles to User

path Parameters

userUuid

required

string

User UUID

Request Body schema: application/json

Role UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Enable User

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Disable User

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Get User permissions

path Parameters

userUuid

required

string

User UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"allowAllResources": true,
"resources": [{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}
]
}

ACME Account Management

ACME Account Management API

Revoke multiple ACME Accounts

Request Body schema: application/json

ACME Account UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Details of ACME Account

path Parameters

acmeProfileUuid required	string ACME Profile UUID
acmeAccountUuid required	string ACME Account UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"accountId": "TtrgfYTR6F",
"uuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"enabled": false,
"totalOrders": 23,
"successfulOrders": 2,
"failedOrders": 239,
"pendingOrders": 24,
"validOrders": 23,
"processingOrders": 27,
"status": "VALID",
"contact": "mailto: someadmin@domain.com",
"termsOfServiceAgreed": true,
"raProfileName": "RA Profile 1",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"acmeProfileName": "ACME Profile 1",
"acmeProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002"
}

Revoke ACME Account

path Parameters

acmeProfileUuid required	string ACME Profile UUID
acmeAccountUuid required	string ACME Account UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable ACME Account

path Parameters

acmeProfileUuid required	string ACME Profile UUID
acmeAccountUuid required	string ACME Account UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable ACME Account

path Parameters

acmeProfileUuid required	string ACME Profile UUID
acmeAccountUuid required	string ACME Account UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable multiple ACME Accounts

Request Body schema: application/json

ACME Account UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable multiple ACME Accounts

Request Body schema: application/json

ACME Account UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List ACME Accounts

Responses

Response samples

200
400
403
404

Content type

application/json

[{"accountId": "HJAT6gc7i6",
"uuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"enabled": false,
"totalOrders": 4,
"status": "VALID",
"raProfileName": "RAProfile1",
"acmeProfileName": "ACMEProfile1",
"acmeProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002"
}
]

Authentication Management

Authentication Management API

Profile Authorization

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Update User Profile

Request Body schema: application/json

description	string Description of the user
firstName	string First name of the user
lastName	string Last name of the user
email required	string Email of the user
certificateData	string Base64 Content of the admin certificate
certificateUuid	string UUID of the existing certificate in the Inventory. Mandatory if certificate is not provided
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"certificateData": "string",
"certificateUuid": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Get List of objects for Object Access

path Parameters

resourceName

required

string (Resource)

Enum: "NONE" "dashboard" "auditLogs" "credentials" "connectors" "users" "roles" "acmeAccounts" "acmeProfiles" "authorities" "raProfiles" "certificates" "certificateGroups" "complianceProfiles" "discoveries" "entities" "locations" "attributes"

Resource Name

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]

Get all Resources

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"displayName": "string",
"listObjectsEndpoint": "string",
"objectAccess": true,
"actions": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"displayName": "string"
}
]
}
]

Audit Log

Audit Log API

List Status

Responses

Response samples

200
400
403
404

Content type

application/json

["string"
]

Purge Audit logs

query Parameters

	object (AuditLogFilter)
	object (Pageable)

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List Audit Operations

Responses

Response samples

200
400
403
404

Content type

application/json

["string"
]

List Audit Objects

Responses

Response samples

200
400
403
404

Content type

application/json

["string"
]

Export Audit logs

query Parameters

	object (AuditLogFilter)
	object (Pageable)

Responses

Response samples

200
400
403
404

Content type

application/json

"string"

List Audit logs

query Parameters

	object (AuditLogFilter)
	object (Pageable)

Responses

Response samples

200
400
403
404

Content type

application/json

{"page": 0,
"size": 0,
"totalPages": 0,
"items": [{"id": 0,
"uuid": "string",
"author": "string",
"created": "2019-08-24T14:15:22Z",
"operationStatus": "SUCCESS",
"origination": "ACCESS",
"affected": "ACCESS",
"objectIdentifier": "string",
"operation": "CREATE",
"additionalData": "string"
}
]
}

Client Operations v2

Client Operations v2 API

Revoke Certificate

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID
certificateUuid required	string Certificate UUID

Request Body schema: application/json

reason required	string Enum: "UNSPECIFIED" "KEY_COMPROMISE" "CA_COMPROMISE" "AFFILIATION_CHANGED" "SUPERSEDED" "CESSATION_OF_OPERATION" "CERTIFICATE_HOLD" "REMOVE_FROM_CRL" "PRIVILEGES_WITHDRAWN" "AA_COMPROMISE" Reason for revocation
required	Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate

Responses

Request samples

Payload

Content type

application/json

{"reason": "UNSPECIFIED",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Renew Certificate

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID
certificateUuid required	string Certificate UUID

Request Body schema: application/json

pkcs10 required	string Certificate sign request (PKCS#10) encoded as Base64 string
replaceInLocations	boolean Default: false True to replace renewed certificate in the associated locations

Responses

Request samples

Payload

Content type

application/json

{"pkcs10": "string",
"replaceInLocations": false
}

Response samples

Content type

application/json

{"certificateData": "string",
"uuid": "string"
}

Issue Certificate

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Request Body schema: application/json

pkcs10 required	string Certificate sign request (PKCS#10) encoded as Base64 string
required	Array of objects (RequestAttributeDto) List of Attributes to issue Certificate
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"pkcs10": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"certificateData": "string",
"uuid": "string"
}

Validate revocation Attributes

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Request Body schema: application/json

Array

uuid	string UUID of the Attribute
name required	string Name of the Attribute
required	Array of BooleanAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContent) Content of the Attribute

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Validate issue Certificate Attributes

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Request Body schema: application/json

Array

uuid	string UUID of the Attribute
name required	string Name of the Attribute
required	Array of BooleanAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContent) Content of the Attribute

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]

Response samples

Content type

application/json

{"message": "Error message"
}

Get revocation Attributes

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Get issue Certificate Attributes

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Global Metadata

Global Metadata API

Global Metadata details

path Parameters

uuid

required

string

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"name": "string",
"contentType": "Attribute",
"description": "string",
"enabled": true,
"type": "data",
"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes"
}

Edit Global Metadata

path Parameters

uuid

required

string

Global Metadata UUID

Request Body schema: application/json

description required	string Attribute description
label required	string Friendly name of the the Attribute
visible	boolean Default: true Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user.
group	string Group of the Attribute, used for the logical grouping of the Attribute

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes"
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"name": "string",
"contentType": "Attribute",
"description": "string",
"enabled": true,
"type": "data",
"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes"
}

Delete Global Metadata

path Parameters

uuid

required

string

Global Metadata UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Available Connector Metadata

query Parameters

connectorUuid

string

Responses

Response samples

204
400
403
404

Content type

application/json

[{"name": "string",
"uuid": "string",
"contentType": "Attribute",
"label": "string",
"connectorUuid": "string"
}
]

Promote Connector Metadata to Global Metadata

Request Body schema: application/json

uuid required	string Metadata UUID
connectorUuid required	string Connector UUID

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"connectorUuid": "string"
}

Response samples

204
400
403
404

Content type

application/json

{"uuid": "string",
"name": "string",
"contentType": "Attribute",
"description": "string",
"enabled": true,
"type": "data",
"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes"
}

List Global Metadata

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "string",
"name": "string",
"contentType": "Attribute",
"description": "string",
"enabled": true
}
]

Create Global Metadata

Request Body schema: application/json

name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "integer" "secret" "file" "boolean" "credential" "date" "float" "object" "text" "time" "datetime" Content Type of the Attribute
description required	string Attribute description
label required	string Friendly name of the the Attribute
visible	boolean Default: true Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user.
group	string Group of the Attribute, used for the logical grouping of the Attribute

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"contentType": "Attribute",
"description": "string",
"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes"
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "string"
}

Delete multiple Global Metadata

Request Body schema: application/json

Global Metadata UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Statistics/Dashboard

Statistics/Dashboard API

Get Dashboard/Statistics Details

Responses

Response samples

200
400
403
404

Content type

application/json

{"totalCertificates": 0,
"totalGroups": 0,
"totalDiscoveries": 0,
"totalConnectors": 0,
"totalRaProfiles": 0,
"totalCredentials": 0,
"totalAuthorities": 0,
"totalAdministrators": 0,
"totalClients": 0,
"groupStatByCertificateCount": {"property1": 0,
"property2": 0
},
"raProfileStatByCertificateCount": {"property1": 0,
"property2": 0
},
"certificateStatByType": {"property1": 0,
"property2": 0
},
"certificateStatByExpiry": {"property1": 0,
"property2": 0
},
"certificateStatByKeySize": {"property1": 0,
"property2": 0
},
"certificateStatByBasicConstraints": {"property1": 0,
"property2": 0
},
"certificateStatByStatus": {"property1": 0,
"property2": 0
},
"certificateStatByComplianceStatus": {"property1": 0,
"property2": 0
},
"connectorStatByStatus": {"property1": 0,
"property2": 0
},
"raProfileStatByStatus": {"property1": 0,
"property2": 0
},
"administratorStatByStatus": {"property1": 0,
"property2": 0
},
"clientStatByStatus": {"property1": 0,
"property2": 0
}
}

Local operations

API only accessible from localhost

Create Administrator

Request Body schema: application/json

username required	string Username of the user
description	string Description of the user
firstName	string First name of the user
lastName	string Last name of the user
email	string Email of the user
enabled	boolean Status of the user. True = Enabled, False = Disabled
certificateData	string Base64 Content of the user certificate
certificateUuid	string UUID of the existing certificate in the Inventory
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"username": "user1",
"description": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"enabled": true,
"certificateData": "string",
"certificateUuid": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true,
"certificate": {"uuid": "string",
"fingerprint": "string"
},
"roles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Credential Management

Credential Management API

Details of a Credentials

path Parameters

uuid

required

string

Credential UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"kind": "SoftKeyStore, Basic, ApiKey, etc",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"connectorUuid": "string",
"connectorName": "string"
}

Edit Credential

path Parameters

uuid

required

string

Credential UUID

Request Body schema: application/json

required	Array of objects (RequestAttributeDto) List of Credential Attributes
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"kind": "SoftKeyStore, Basic, ApiKey, etc",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"connectorUuid": "string",
"connectorName": "string"
}

Delete Credential

path Parameters

uuid

required

string

Credential UUID

Responses

Response samples

Content type

application/json

{"message": "Error message"
}

List of All Credentials

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"kind": "SoftKeyStore, Basic, ApiKey, etc",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"connectorUuid": "string",
"connectorName": "string"
}
]

Add Credential

Request Body schema: application/json

name required	string Credential name
kind required	string Credential Kind
required	Array of objects (RequestAttributeDto) List of Credential Attributes
	Array of objects (RequestAttributeDto) List of Custom Attributes
connectorUuid required	string UUID of Credential provider Connector

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"kind": "SoftKeyStore, Basic, ApiKey, etc",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"connectorUuid": "string"
}

Response samples

Content type

application/json

{"uuid": "string"
}

Delete multiple Credentials

Request Body schema: application/json

Credential UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

{"message": "Error message"
}

Enable Credential

path Parameters

uuid

required

string

Credential UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Disable Credential

path Parameters

uuid

required

string

Credential UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Callback

Callback API

RA Profile Callback API

API to trigger the Callback for RA Profile.

path Parameters

authorityUuid

required

string

Authority instance UUID

Request Body schema: application/json

uuid	string UUID of the Attribute
name required	string Name of the Attribute
	object Map of path variables supported by the callback method
	object Map of the query parameters supported by the callback method
	object Request body for the callback method

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"name": "string",
"pathVariable": {"property1": { },
"property2": { }
},
"requestParameter": {"property1": { },
"property2": { }
},
"body": {"property1": { },
"property2": { }
}
}

Response samples

200
400
404
502
503

Content type

application/json

{ }

Connector Callback API

API to trigger the Callback for Connector.

path Parameters

uuid required	string Connector UUID
functionGroup required	string Function Group
kind required	string Kind

Request Body schema: application/json

uuid	string UUID of the Attribute
name required	string Name of the Attribute
	object Map of path variables supported by the callback method
	object Map of the query parameters supported by the callback method
	object Request body for the callback method

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"name": "string",
"pathVariable": {"property1": { },
"property2": { }
},
"requestParameter": {"property1": { },
"property2": { }
},
"body": {"property1": { },
"property2": { }
}
}

Response samples

200
400
404
502
503

Content type

application/json

{ }

Certificate Group

Certificate Group API

Group details

path Parameters

uuid

required

string

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Edit Group

path Parameters

uuid

required

string

Group UUID

Request Body schema: application/json

name required	string Name of the Certificate Group
description	string Description of the Certificate Group
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Delete Group

path Parameters

uuid

required

string

Group UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List Groups

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
]

Create Group

Request Body schema: application/json

name required	string Name of the Certificate Group
description	string Description of the Certificate Group
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "string"
}

Delete multiple Groups

Request Body schema: application/json

Group UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Certificate Inventory

Certificate Inventory API

Get Certificate Validation Result

path Parameters

uuid

required

string

Certificate UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"property1": {"status": "success",
"message": "string"
},
"property2": {"status": "success",
"message": "string"
}
}

Initiate Certificate validation

path Parameters

uuid

required

string

Certificate UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Validate Certificates of Status Unknown

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Upload a new Certificate

Request Body schema: application/json

certificate

required

string

Base64 Content of the Certificate

Responses

Request samples

Payload

Content type

application/json

{"certificate": "string"
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "string"
}

Delete multiple certificates

In this operation, when the list of Certificate UUIDs are provided and the filter is left as null or undefined, then the change will be applied only to the list of Certificate UUIDs provided. When the filter is provided in the request, the list of UUIDs will be ignored and the change will be applied for the all the certificates that matches the filter criteria. To apply this change for all the Certificates in the inventory, provide an empty array "[]" for the value of "filters" in the request body

Request Body schema: application/json

uuids	Array of strings List of Certificate UUIDs
	Array of objects (SearchFilterRequestDto) Certificate filter input

Responses

Request samples

Payload

Content type

application/json

{"uuids": ["string"
],
"filters": [{"field": "commonName",
"condition": "EQUALS",
"value": { }
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"status": "SUCCESS",
"failedItem": 0,
"message": "string"
}

Initiate Certificate Compliance Check

Request Body schema: application/json

certificateUuids

Array of strings

List of UUIDs of the Certificates

Responses

Request samples

Payload

Content type

application/json

{"certificateUuids": ["string"
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

List Certificates

Request Body schema: application/json

	Array of objects (SearchFilterRequestDto) Certificate filter input
itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"field": "commonName",
"condition": "EQUALS",
"value": { }
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

200
400
403
404

Content type

application/json

{"certificates": [{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"certificateContent": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"keySize": 0,
"extendedKeyUsage": ["string"
],
"keyUsage": ["string"
],
"basicConstraints": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
],
"status": "valid",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"subjectAlternativeNames": {"property1": { },
"property2": { }
},
"locations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [null
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [null
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [null
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [null
],
"sourceObjectType": "string",
"sourceObjects": [null
]
}
]
}
]
}
],
"group": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
},
"owner": "string",
"certificateType": "X509",
"issuerSerialNumber": "string",
"nonCompliantRules": [{"connectorName": "Provider1",
"ruleName": "RuleName",
"ruleDescription": "Description sample",
"status": "nok",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"complianceStatus": "ok",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

Update RA Profile, Group, Owner for multiple Certificates

In this operation, when the list of Certificate UUIDs are provided and the filter is left as null or undefined, then the change will be applied only to the list of Certificate UUIDs provided. When the filter is provided in the request, the list of UUIDs will be ignored and the change will be applied for the all the certificates that matches the filter criteria. To apply this change for all the Certificates in the inventory, provide an empty array "[]" for the value of "filters" in the request body

Request Body schema: application/json

raProfileUuid	string UUID of the RA Profile
groupUuid	string UUID of the Certificate Group
owner	string Certificate Owner
certificateUuids	Array of strings List of Certificate UUIDs
	Array of objects (SearchFilterRequestDto) Certificate filter input

Responses

Request samples

Payload

Content type

application/json

{"raProfileUuid": "string",
"groupUuid": "string",
"owner": "string",
"certificateUuids": ["string"
],
"filters": [{"field": "commonName",
"condition": "EQUALS",
"value": { }
}
]
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Certificate Details

path Parameters

uuid

required

string

Certificate UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"certificateContent": "string",
"issuerDn": "string",
"subjectDn": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"publicKeyAlgorithm": "string",
"signatureAlgorithm": "string",
"keySize": 0,
"extendedKeyUsage": ["string"
],
"keyUsage": ["string"
],
"basicConstraints": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
],
"status": "valid",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
},
"fingerprint": "string",
"subjectAlternativeNames": {"property1": { },
"property2": { }
},
"locations": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [null
],
"sourceObjectType": "string",
"sourceObjects": [null
]
}
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}
],
"group": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
},
"owner": "string",
"certificateType": "X509",
"issuerSerialNumber": "string",
"nonCompliantRules": [{"connectorName": "Provider1",
"ruleName": "RuleName",
"ruleDescription": "Description sample",
"status": "nok",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"complianceStatus": "ok",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Delete a certificate

path Parameters

uuid

required

string

Certificate UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Update Certificate Objects

path Parameters

uuid

required

string

Certificate UUID

Request Body schema: application/json

raProfileUuid	string RA Profile UUID
groupUuid	string Group UUID
owner	string Certificate Owner

Responses

Request samples

Payload

Content type

application/json

{"raProfileUuid": "string",
"groupUuid": "string",
"owner": "string"
}

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get Certificate event history

path Parameters

uuid

required

string

Certificate UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "string",
"certificateUuid": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"event": "Issue Certificate",
"status": "SUCCESS",
"message": "string",
"additionalInformation": {"property1": { },
"property2": { }
}
}
]

List of available Locations for the Certificate

path Parameters

certificateUuid

required

string

Certificate UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": null,
"data": null
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": null,
"name": null
}
]
}
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}
]

Get Certificate searchable fields information

Responses

Response samples

200
400
403
404

Content type

application/json

[{"field": "commonName",
"label": "string",
"type": "string",
"conditions": ["EQUALS"
],
"value": { },
"multiValue": true
}
]

Compliance Profile Management

Compliance Profile Management API

Add rule to a Compliance Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Request Body schema: application/json

connectorUuid required	string UUID of the Compliance Provider
kind required	string Kind of the Compliance Provider
ruleUuid required	string UUID of the rule
	Array of objects (RequestAttributeDto) Attributes for the rule

Responses

Request samples

Payload

Content type

application/json

{"connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
"kind": "default",
"ruleUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "Sample rule description",
"connectorName": "string",
"connectorUuid": "string",
"kind": "string",
"groupUuid": "string",
"certificateType": "X509",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"complianceProfileUuid": "string",
"complianceProfileName": "string"
}

Delete rule from a Compliance Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Request Body schema: application/json

connectorUuid required	string UUID of the Compliance Provider
kind required	string Kind of the Compliance Provider
ruleUuid required	string UUID of the rule

Responses

Request samples

Payload

Content type

application/json

{"connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
"kind": "default",
"ruleUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3"
}

Response samples

Content type

application/json

{"message": "Error message"
}

Add group to a Compliance Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Request Body schema: application/json

connectorUuid required	string UUID of the Compliance Provider
kind required	string Kind of the Compliance Provider
groupUuid required	string UUID of the group

Responses

Request samples

Payload

Content type

application/json

{"connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
"kind": "default",
"groupUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3"
}

Response samples

Content type

application/json

{"message": "Error message"
}

Delete group from a Compliance Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Request Body schema: application/json

connectorUuid required	string UUID of the Compliance Provider
kind required	string Kind of the Compliance Provider
groupUuid required	string UUID of the group

Responses

Request samples

Payload

Content type

application/json

{"connectorUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3",
"kind": "default",
"groupUuid": "1212a-34dddf34-4334f-34ddfvfdg1y3"
}

Response samples

Content type

application/json

{"message": "Error message"
}

Initiate Certificate Compliance Check

Request Body schema: application/json

RA Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

List of available Compliance Profiles

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"rules": [{"connectorName": "string",
"numberOfRules": 0,
"numberOfGroups": 0
}
]
}
]

Add Compliance Profile

Request Body schema: application/json

name required	string Name of the Compliance Profile
description	string Description of the Compliance Profile
	Array of objects (ComplianceProfileRulesRequestDto) Rules to be associated with the Compliance Profile. Profiles can be created without rules and can be added later
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "Profile 1",
"description": "Profile 1",
"rules": [{"connectorUuid": "c35bc88c-d0ef-11ec-9d64-0242ac120005",
"kind": "x509",
"rules": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
],
"groups": ["string"
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"uuid": "string"
}

Delete multiple Compliance Profiles

Request Body schema: application/json

Compliance Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Disassociate Compliance Profile to RA Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Request Body schema: application/json

raProfileUuids

required

Array of strings

List of UUIDs of RA Profiles to be associated

Responses

Request samples

Payload

Content type

application/json

{"raProfileUuids": ["18324af0-e95c-11ec-8fea-0242ac120002",
"18324c94-e95c-11ec-8fea-0242ac120002"
]
}

Response samples

Content type

application/json

{"message": "Error message"
}

Associate Compliance Profile to RA Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Request Body schema: application/json

raProfileUuids

required

Array of strings

List of UUIDs of RA Profiles to be associated

Responses

Request samples

Payload

Content type

application/json

{"raProfileUuids": ["18324af0-e95c-11ec-8fea-0242ac120002",
"18324c94-e95c-11ec-8fea-0242ac120002"
]
}

Response samples

Content type

application/json

{"message": "Error message"
}

Get RA Profiles for a Compliance Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
}
]

Details of a Compliance Profiles

path Parameters

uuid

required

string

Compliance Profile UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"rules": [{"connectorName": "string",
"connectorUuid": "string",
"kind": "string",
"rules": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "Sample rule description",
"certificateType": "X509",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
]
}
],
"groups": [{"connectorName": "string",
"connectorUuid": "string",
"kind": "string",
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "Sample group description"
}
]
}
],
"raProfiles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"authorityInstanceUuid": "string"
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Delete Compliance Profile

path Parameters

uuid

required

string

Compliance Profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Get Compliance rules

query Parameters

complianceProvider	string
kind	string
certificateType	Array of strings (CertificateType) Items Enum: "X509" "SSH" Example: certificateType=X509

Responses

Response samples

Content type

application/json

[{"connectorName": "Provider1",
"connectorUuid": "c35bc88c-d0ef-11ec-9d64-0242ac120003",
"kind": "Kind1",
"rules": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"groupUuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Rule1",
"certificateType": "X509",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": [null
],
"value": { }
}
]
}
}
],
"description": "Sample rule description"
}
]
}
]

Get Compliance groups

query Parameters

complianceProvider	string
kind	string

Responses

Response samples

Content type

application/json

[{"connectorName": "Provider1",
"connectorUuid": "c35bc88c-d0ef-11ec-9d64-0242ac120003",
"kind": "Kind1",
"groups": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "RFC",
"description": "Sample description of the group"
}
]
}
]

Force delete Compliance Profiles

Request Body schema: application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Location Management

Location Management API

Sync Location content

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}

Push Certificate to Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID
certificateUuid required	string Certificate UUID

Request Body schema: application/json

required

Array of objects (RequestAttributeDto)

List of push Attributes for Location

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}

Remove Certificate from Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID
certificateUuid required	string Certificate UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}

Renew Certificate in Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID
certificateUuid required	string Certificate UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}

Get Location Details

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}

Edit Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Request Body schema: application/json

description	string Description of the Location
required	Array of objects (RequestAttributeDto) List of Attributes for Location
	Array of objects (RequestAttributeDto) List of Custom Attributes
enabled	boolean Enabled flag - true = enabled; false = disabled

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}

Delete Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Responses

Issue Certificate to Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Request Body schema: application/json

raProfileUuid required	string RA Profile UUID
required	Array of objects (RequestAttributeDto) List of CSR Attributes for Location
required	Array of objects (RequestAttributeDto) List of certificate issue Attributes for RA Profile
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"raProfileUuid": "string",
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"issueAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}

Add Location

path Parameters

entityUuid

required

string

Entity UUID

Request Body schema: application/json

name required	string Location name
description	string Location description
required	Array of objects (RequestAttributeDto) List of Attributes to register Location
	Array of objects (RequestAttributeDto) List of Custom Attributes
enabled	boolean Default: false Enabled flag - true = enabled; false = disabled

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": false
}

Response samples

Content type

application/json

{"uuid": "string"
}

Enable Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Responses

Disable Location

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Responses

List Locations

query Parameters

enabled

boolean

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"entityInstanceUuid": "string",
"entityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"supportMultipleEntries": false,
"supportKeyManagement": false,
"certificates": [{"certificateUuid": "string",
"commonName": "string",
"serialNumber": "string",
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": null,
"data": null
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": null,
"name": null
}
]
}
]
}
],
"pushAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"csrAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"withKey": false
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}
]

Get push Attributes

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Responses

Response samples

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Get CSR Attributes

path Parameters

entityUuid required	string Entity UUID
locationUuid required	string Location UUID

Responses

Response samples

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Entity Management

Entity Management API

Get Entity instance details

path Parameters

entityUuid

required

string

Entity instance UUID

Responses

Response samples

200
400
404
502
503

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "Keystore, etc."
}

Edit Entity instance

path Parameters

entityUuid

required

string

Entity instance UUID

Request Body schema: application/json

required	Array of objects (RequestAttributeDto) List of Entity instance Attributes
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "Keystore, etc."
}

Delete Entity instance

path Parameters

entityUuid

required

string

Entity instance UUID

Responses

Validate Location Attributes

path Parameters

entityUuid

required

string

Entity instance UUID

Request Body schema: application/json

Array

uuid	string UUID of the Attribute
name required	string Name of the Attribute
required	Array of BooleanAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContent) Content of the Attribute

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]

Response samples

422

Content type

*/*

[
  "Error Message 1",
  "Error Message 2"
]

List Entity instances

Responses

Response samples

200
400
404
502
503

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "Keystore, etc."
}
]

Add Entity instance

Request Body schema: application/json

name required	string Entity instance name
required	Array of objects (RequestAttributeDto) List of Entity instance Attributes
	Array of objects (RequestAttributeDto) List of Custom Attributes
connectorUuid required	string UUID of Entity Provider
kind required	string Entity instance Kind

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"connectorUuid": "string",
"kind": "Keystore, etc."
}

Response samples

Content type

application/json

{"uuid": "string"
}

List Location Attributes

path Parameters

entityUuid

required

string

Entity instance UUID

Responses

Response samples

200
400
404
502
503

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Authority Management

Authority Management API

Details of an Authority instance

path Parameters

uuid

required

string

Authority instance UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "LegacyEjbca, ADCS, etc."
}

Edit Authority instance

path Parameters

uuid

required

string

Authority instance UUID

Request Body schema: application/json

required	Array of objects (RequestAttributeDto) List of Authority instance Attributes
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "LegacyEjbca, ADCS, etc."
}

Delete Authority instance

path Parameters

uuid

required

string

Authority instance UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Validate RA Profile Attributes

path Parameters

uuid

required

string

Authority instance UUID

Request Body schema: application/json

Array

uuid	string UUID of the Attribute
name required	string Name of the Attribute
required	Array of BooleanAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContent) Content of the Attribute

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

List of available Authority instances

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "LegacyEjbca, ADCS, etc."
}
]

Add Authority instance

Request Body schema: application/json

name required	string Authority instance name
required	Array of objects (RequestAttributeDto) List of Authority instance Attributes
	Array of objects (RequestAttributeDto) List of Custom Attributes
connectorUuid required	string UUID of Authority provider
kind required	string Authority instance Kind

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"connectorUuid": "string",
"kind": "LegacyEjbca, ADCS, etc"
}

Response samples

Content type

application/json

{"uuid": "string"
}

Delete multiple Authority instances

Request Body schema: application/json

Authority Instance UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

listCertificateProfiles

path Parameters

uuid required	string Authority instance UUID
endEntityProfileId required	integer <int32>

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string"
}
]

listCAsInProfile

path Parameters

uuid required	string Authority instance UUID
endEntityProfileId required	integer <int32>

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string"
}
]

listEntityProfiles

path Parameters

uuid

required

string

Authority instance UUID

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string"
}
]

List RA Profile Attributes

path Parameters

uuid

required

string

Authority instance UUID

Responses

Response samples

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Force delete multiple Authority instances

Request Body schema: application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

RA Profile Management

RA Profile Management API

Details of RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"authorityInstanceUuid": "string",
"authorityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"enabledProtocols": ["string"
]
}

Edit RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Request Body schema: application/json

description	string Description of RA Profile
required	Array of objects (RequestAttributeDto) List of Attributes for RA Profile
	Array of objects (RequestAttributeDto) List of Custom Attributes
enabled	boolean Enabled flag - true = enabled; false = disabled

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"authorityInstanceUuid": "string",
"authorityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"enabledProtocols": ["string"
]
}

Delete RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Initiate Certificate Compliance Check

Request Body schema: application/json

RA Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Create RA Profile

path Parameters

authorityUuid

required

string

Authority Instance UUID

Request Body schema: application/json

name required	string RA Profile name
description	string RA Profile description
required	Array of objects (RequestAttributeDto) List of Attributes to create RA Profile
	Array of objects (RequestAttributeDto) List of Custom Attributes
enabled	boolean Default: false Enabled flag - true = enabled; false = disabled

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": false
}

Response samples

Content type

application/json

{"uuid": "string"
}

Enable multiple RA Profiles

Request Body schema: application/json

RA Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Disable multiple RA Profiles

Request Body schema: application/json

RA Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Enable RA Profiles

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Disable RA Profiles

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Deactivate ACME for RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

{"message": "Error message"
}

Activate ACME for RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID
acmeProfileUuid required	string ACME Profile UUID

Request Body schema: application/json

required	Array of objects (RequestAttributeDto) List of Attributes to issue Certificate
required	Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate

Responses

Request samples

Payload

Content type

application/json

{"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"directoryUrl": "string",
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"acmeAvailable": true
}

Details of RA Profile

path Parameters

raProfileUuid

required

string

RA Profile UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"authorityInstanceUuid": "string",
"authorityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"enabledProtocols": ["string"
]
}

Delete RA Profile

path Parameters

raProfileUuid

required

string

RA Profile UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

List of available RA Profiles

query Parameters

enabled

boolean

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"authorityInstanceUuid": "string",
"authorityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"enabledProtocols": ["string"
]
}
]

Delete multiple RA Profiles

Request Body schema: application/json

RA Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

{"message": "Error message"
}

Get Compliance Profiles for an RA Profile

path Parameters

authorityUuid required	string Authority UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string"
}
]

Get revocation Attributes

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Get issue Certificate Attributes

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Get ACME details for RA Profile

path Parameters

authorityUuid required	string Authority Instance UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"directoryUrl": "string",
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"acmeAvailable": true
}

Discovery Management

Discovery Management API

List Discovery

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"kind": "IP-HostName",
"status": "inProgress",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"totalCertificatesDiscovered": 0,
"connectorUuid": "string",
"connectorName": "string"
}
]

Create Discovery

Request Body schema: application/json

name required	string Discovery name
required	Array of objects (RequestAttributeDto) List of Attributes for Discovery
	Array of objects (RequestAttributeDto) List of Custom Attributes
connectorUuid required	string Discovery Provider UUID
kind required	string Discovery Kind

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"connectorUuid": "string",
"kind": "string"
}

Response samples

Content type

application/json

{"uuid": "string"
}

Delete Multiple Discoveries

Request Body schema: application/json

Discovery UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Discovery Details

path Parameters

uuid

required

string

Discovery UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"kind": "IP-HostName",
"status": "inProgress",
"message": "Failed due to network connectivity issues",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"totalCertificatesDiscovered": 0,
"connectorUuid": "string",
"connectorName": "string",
"certificate": [{"uuid": "string",
"commonName": "string",
"serialNumber": "string",
"issuerCommonName": "string",
"notBefore": "2019-08-24T14:15:22Z",
"notAfter": "2019-08-24T14:15:22Z",
"fingerprint": "string",
"certificateContent": "string"
}
],
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"items": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
],
"sourceObjectType": "string",
"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
]
}
]
}
]
}

Delete Discovery

path Parameters

uuid

required

string

Discovery UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

ACME Profile Management

ACME Profile Management API

Get details of ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"description": "Sample description",
"termsOfServiceUrl": "https://sample-url.com/termsOfService",
"websiteUrl": "https://sample-company.com",
"dnsResolverIp": "8.8.8.8",
"dnsResolverPort": "53",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"authorityInstanceUuid": "string",
"authorityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"enabledProtocols": ["string"
]
},
"retryInterval": 30,
"termsOfServiceChangeDisable": false,
"validity": 36000,
"directoryUrl": "https://some-server.com/api/acme/profile1/directory",
"termsOfServiceChangeUrl": "https://some-company.com/termsOfService/change",
"requireContact": true,
"requireTermsOfService": true,
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Edit ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Request Body schema: application/json

description	string Description of the ACME Profile
termsOfServiceUrl	string Terms of Service URL
websiteUrl	string Website URL
dnsResolverIp	string Default: "System Default" DNS Resolver IP address
dnsResolverPort	string Default: "53" DNS Resolver port number
raProfileUuid	string RA Profile UUID
retryInterval	integer <int32> Default: 30 Retry interval for the Orders
termsOfServiceChangeDisable	boolean Default: false Disable new Orders due to change in Terms of Service
termsOfServiceChangeUrl	string Changes of Terms of Service URL
validity	integer <int32> Default: 36000 Order Validity
required	Array of objects (RequestAttributeDto) List of Attributes to issue Certificate
required	Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate
requireContact	boolean Default: false Require contact information for new Account
requireTermsOfService	boolean Default: false Require new Account to agree on Terms of Service
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"description": "Sample description",
"termsOfServiceUrl": "https://sample-url.com/termsOfService",
"websiteUrl": "https://sample-url.com",
"dnsResolverIp": "8.8.8.8",
"dnsResolverPort": "53",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"retryInterval": 60,
"termsOfServiceChangeDisable": false,
"termsOfServiceChangeUrl": "https://sample-url.com/termsOfService/change",
"validity": 3000,
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"requireContact": true,
"requireTermsOfService": false,
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": true,
"description": "Sample description",
"termsOfServiceUrl": "https://sample-url.com/termsOfService",
"websiteUrl": "https://sample-company.com",
"dnsResolverIp": "8.8.8.8",
"dnsResolverPort": "53",
"raProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"authorityInstanceUuid": "string",
"authorityInstanceName": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"enabled": true,
"enabledProtocols": ["string"
]
},
"retryInterval": 30,
"termsOfServiceChangeDisable": false,
"validity": 36000,
"directoryUrl": "https://some-server.com/api/acme/profile1/directory",
"termsOfServiceChangeUrl": "https://some-company.com/termsOfService/change",
"requireContact": true,
"requireTermsOfService": true,
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Delete ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get list of ACME Profiles

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"enabled": false,
"description": "Some description",
"raProfileName": "RA Profile 1",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"directoryUrl": "https://some-server.com/api/acme/profile1/directory"
}
]

Create ACME Profile

Request Body schema: application/json

name required	string Name of the ACME Profile
description	string Description of the ACME Profile
termsOfServiceUrl	string Terms of Service URL
websiteUrl	string Website URL
dnsResolverIp	string Default: "System Default" DNS Resolver IP address
dnsResolverPort	string Default: "53" DNS Resolver port number
raProfileUuid	string RA Profile UUID
retryInterval	integer <int32> Default: 30 Retry interval for the Orders
validity	integer <int32> Default: 36000 Order Validity
required	Array of objects (RequestAttributeDto) List of Attributes to issue Certificate
required	Array of objects (RequestAttributeDto) List of Attributes to revoke Certificate
requireContact	boolean Default: false Require contact information for new Account
requireTermsOfService	boolean Default: false Require new Account to agree on Terms of Service
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "Profile Name 1",
"description": "Sample description",
"termsOfServiceUrl": "https://sample-url.com/termsOfService",
"websiteUrl": "https://sample-url.com",
"dnsResolverIp": "8.8.8.8",
"dnsResolverPort": "53",
"raProfileUuid": "6b55de1c-844f-11ec-a8a3-0242ac120002",
"retryInterval": 60,
"validity": 3000,
"issueCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"revokeCertificateAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"requireContact": true,
"requireTermsOfService": false,
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "string"
}

Update RA Profile for ACME Profile

path Parameters

uuid required	string ACME Profile UUID
raProfileUuid required	string RA Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable ACME Profile

path Parameters

uuid

required

string

ACME Profile UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Enable multiple ACME Profiles

Request Body schema: application/json

ACME Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Disable multiple ACME Profile

Request Body schema: application/json

ACME Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Force delete multiple ACME Profiles

Request Body schema: application/json

ACME Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
404
422

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Delete multiple ACME Profiles

Request Body schema: application/json

ACME Profile UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Connector Authentication

Connector Authentication API

Validate JWT auth Attributes

Request Body schema: application/json

Array

uuid	string UUID of the Attribute
name required	string Name of the Attribute
required	Array of BooleanAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContent) Content of the Attribute

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Validate certificate auth Attributes

Request Body schema: application/json

Array

uuid	string UUID of the Attribute
name required	string Name of the Attribute
required	Array of BooleanAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContent) Content of the Attribute

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Validate basic auth Attributes

Request Body schema: application/json

Array

uuid	string UUID of the Attribute
name required	string Name of the Attribute
required	Array of BooleanAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContent) Content of the Attribute

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Validate API Key Attributes

Request Body schema: application/json

Array

uuid	string UUID of the Attribute
name required	string Name of the Attribute
required	Array of BooleanAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContent) Content of the Attribute

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get list of Authentication Types

Responses

Response samples

200
400
403
404

Content type

application/json

["string"
]

Get JWT auth Attributes

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Get Attributes for certificate auth

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Get basic auth Attributes

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Get API Key auth Attributes

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "Attribute",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "Attribute",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Connector Registration

Connector Registration API

Register a Connector

Request Body schema: application/json

name required	string Name of the Connector
url required	string URL of the Connector to connect
authType required	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttributeDto) List of authentication Attributes. Required if the authentication type is not NONE
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "Connector1",
"url": "http://network-discovery-provicer:8080",
"authType": "none",
"authAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

200
400
404
502
503

Content type

application/json

{"uuid": "string"
}

Role Management

Role Management API

Update Resource Objects to a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID
objectUuid required	string Object UUID

Request Body schema: application/json

uuid required	string UUID of the Object
name required	string Name of the Object
allow	Array of strings Allowed Action list
deny	Array of strings Denied Action list

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}

Response samples

400
403
404

Content type

application/json

{"statusCode": 0,
"code": "string",
"message": "string"
}

Update Resource Objects to a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID
objectUuid required	string Object UUID

Responses

Response samples

400
403
404

Content type

application/json

{"statusCode": 0,
"code": "string",
"message": "string"
}

Get role details

path Parameters

roleUuid

required

string

Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true,
"users": [{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Update Role

path Parameters

roleUuid

required

string

Role UUID

Request Body schema: application/json

name	string Name of the role
description	string Description for the role
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true,
"users": [{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Delete Role

path Parameters

roleUuid

required

string

Role UUID

Responses

Response samples

400
403
404

Content type

application/json

{"statusCode": 0,
"code": "string",
"message": "string"
}

Get Resource Objects of a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]

Add Resource Objects to a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID

Request Body schema: application/json

Array

uuid required	string UUID of the Object
name required	string Name of the Object
allow	Array of strings Allowed Action list
deny	Array of strings Denied Action list

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]

Response samples

400
403
404

Content type

application/json

{"statusCode": 0,
"code": "string",
"message": "string"
}

Get Permissions of a Role

path Parameters

roleUuid

required

string

Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"allowAllResources": true,
"resources": [{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}
]
}

Add permissions to Role

path Parameters

roleUuid

required

string

Role UUID

Request Body schema: application/json

allowAllResources required	boolean Allow all resources, True = Yes, False = No
	Array of objects (ResourcePermissionsRequestDto) Resources

Responses

Request samples

Payload

Content type

application/json

{"allowAllResources": true,
"resources": [{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"allowAllResources": true,
"resources": [{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}
]
}

List Roles

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true
}
]

Create Role

Request Body schema: application/json

name	string Name of the role
description	string Description for the role
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

201
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true,
"users": [{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Get Role Users

path Parameters

roleUuid

required

string

Role UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true
}
]

Add users to Role

path Parameters

roleUuid

required

string

Role UUID

Request Body schema: application/json

User UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"description": "string",
"systemRole": true,
"users": [{"uuid": "5b5f0784-2519-11ed-861d-0242ac120002",
"username": "user1",
"firstName": "string",
"lastName": "string",
"email": "string",
"description": "string",
"enabled": true,
"systemUser": true
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "Attribute",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Get Resources of a Role

path Parameters

roleUuid required	string Role UUID
resourceUuid required	string Resource UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"name": "string",
"allowAllActions": true,
"actions": ["string"
],
"objects": [{"uuid": "string",
"name": "string",
"allow": ["string"
],
"deny": ["string"
]
}
]
}